home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / telecomm / storm100.lzh / HELP.INI < prev    next >
Encoding:
INI File  |  1993-11-03  |  11.5 KB  |  281 lines
  1. [HELP]
  2. Help is available on APPEND CAPTURE, ABORT, BAUD, BREAK, CAPTURE, CARRIER,
  3. CD, CHAIN, CLIP, CLOSE, CLR, CLS, COM, COMINPUT, DIR, DLOAD, DTR, DUPLEX,
  4. ENVIRON, EXEC, FKEY, FSEL, FRE, GEM, INPUT, INSTR, KEYINPUT, KILL,
  5. LFEED, LINE INPUT, LOAD, LOAD CAPTURE, LOAD TERM, LOAD XFER, LOG, MENU,
  6. MID$, MKDIR, MODE, OPEN, PARITY, PAUSE, PLAY, REPLACE$, RMDIR, SAVE,
  7. SAVE CAPTURE, SBITS, SEND, SET, STRIP, TA, TERM, TOPW, TYPE, ULOAD,
  8. UNLOAD, WAIT, and WHILE
  9. [ABORT]
  10. ABORT XFER
  11. Aborts a file transfer, if one is in progress
  12. [APPEND CAPTURE]
  13. APPEND CAPTURE "filename" appends the capture buffer to the specified file.
  14. [BAUD]
  15. BAUD nn
  16. Sets baud rate to value nn, where nn is a valid baud rate.
  17. [BREAK]
  18. BREAK ON|OFF| /
  19. Set or reset the hardware break bit in the serial port.
  20. [CAPTURE]
  21. CAPTURE ON|OFF|/ turns text capture on or off or toggles it.
  22. [CARRIER]
  23. CARRIER ON|OFF enables/disables carrier event trapping.
  24. CARRIER CLEAR removes a carrier event trap.
  25. [CD]
  26. CD "path" sets default path.
  27. Path should end with a backslash '\'.
  28. [CHAIN]
  29. Chains to a new Basic. An optional filename specifies a file to run.
  30. [CLIP]
  31. CLIP ON|OFF enables/disables clipboard event trapping.
  32. CLIP CLEAR removes a clipboard trap.
  33. CLIP$ returns the contents of the GEM clipboard.
  34. [CLOSE]
  35. CLOSE #n
  36. Closes a file previously opened with OPEN. Closing a file twice or
  37. using an invalid file number will not cause an error.
  38. [CLR]
  39. Sets all variables to zero, undimensions arrays, frees all strings.
  40. [CLS]
  41. Clears the Basic window.
  42. [COM]
  43. COM ON|OFF enables/disables serial port event trapping.
  44. COM CLEAR removes a serial port trap.
  45. [COMINPUT]
  46. COMINPUT var$[,FULL|,HALF]
  47. Reads data from the serial port into a string variable. The optional
  48. parameter HALF causes serial input to be displayed on the terminal screen.
  49. FULL causes terminal display AND echo back to the sender.
  50. TERM OFF must be set or else characters will be lost.
  51. [DIR]
  52. DIR by itself prints out a directory of the current path.
  53. DIR "pathname" prints a specific directory (wildcards allowed).
  54. [DLOAD]
  55. DLOAD("protocol","file",...)
  56. Downloads one or more files using specified protocol. Returns number of
  57. files transferred.
  58. [DTR]
  59. DTR ON|OFF turns the DTR signal on or off on the serial port.
  60. [DUPLEX]
  61. DUPLEX FULL|HALF|/ sets duplex for the terminal screen.
  62. [ENVIRON]
  63. ENVIRON "aaa=bbb" sets the environment variable "aaa" to value "bbb"
  64. [EXEC]
  65. EXEC mode,"FILENAME","cmdline"
  66. Executes file as a TOS program. Mode should be 0.
  67. [FKEY]
  68. FKEY nnn,"string" assignes a string to a key. The number nnn specifies
  69. which
  70. key.
  71.     For function keys F1 to F10 use the numbers 1 through 10.
  72.     For Shifted function keys F1 to F10, use the numbers 11 through 20.
  73.     The cursor keys numbers are as follows:
  74.     51 is Up        55 is Shift-Up
  75.     52 is Down      56 is Shift-Down
  76.     53 is Right     57 is Shift-Right
  77.     54 is Left      58 is Shift-Left
  78.     To assign a string to a key and have it interpreted as a Basic
  79. command, add 200 to the key number,for both function keys and cursor keys.
  80.     To define ALT-key macros with this command, use the ascii key value as
  81. the key number. Uppercase Ascii for Basic macros, lowercase Ascii for
  82. non-Basic. Examples:
  83.     FKEY ASC("A"),"BAUD 1200"
  84.     FKEY ASC("a"),"This is Alt A"
  85. [FSEL]
  86. FSEL$("path","filename")
  87. Pops op the GEM file selector and returns a filename. "path" is the path
  88. to be displayed in the file selector. It can be a full or partial path,
  89. or just a wildcard spec, e.g. "*.TXT". "filename" is the name to be displayed
  90. initially in the file selector.
  91. [FRE]
  92. FRE(3) returns the number of characters waiting in the serial buffer.
  93. FRE(2) returns the number of bytes in the capture buffer.
  94. FRE(1) returns the number of lines in the capture buffer.
  95. FRE(0) returns the largest available free memory block in the system.
  96. FRE(-1) returns total space used for strings.
  97. FRE(-2) returns the total number of string slots currently allocated.
  98. FRE(-3) returns the number of strings currently in use.
  99. FRE(-4) returns the number of bytes used for storing the current program.
  100. FRE(-5) returns the size in bytes of the variable name table.
  101. FRE(-6) returns the size in bytes of the variable value table.
  102. FRE(-7) returns the size in bytes of the array table. Each element of an
  103. array takes 4 bytes in this table.
  104. FRE(-8) returns the size of the run-time stack.
  105. FRE(-9) returns the number of labels in the label table.
  106. FRE(-10) returns the size in bytes of the label name table.
  107. FRE(-11) returns the number of bytes allocated to the capture buffer.
  108. Any other value returns the same as FRE(0).
  109. [GEM]
  110. GEM mode,"FILENAME","cmdline"
  111. Executes an external GEM program. Mode should be 0.
  112. [INPUT]
  113. INPUT variable
  114. INPUT "prompt";variable
  115. Prompts user for input in the basic window. Optional prompt will appear in
  116. front of the question mark. Input to any Basic variable, including an array.
  117. INPUT #n,variable
  118. For reading data from a file into a variable. n is a file number used in the
  119. OPEN statement that opened the file.
  120. [INSTR]
  121. INSTR([start,]"string","key")
  122. Searches "string" for "key" and returns the location of "key" in "string"
  123. or 0 for failure. Start is the (optional) starting location of the search.
  124. [KEYINPUT]
  125. KEYINPUT var$
  126. Waits for you to press a key in the terminal window and then returns that
  127. key in the string variable. Works only in the terminal window.
  128. [KILL]
  129. KILL "file" deletes a file. Wildcards are allowed.
  130. [LFEED]
  131. LFEED ON|OFF|/
  132.     LFEED ON causes a line feed to be generated internally every time a
  133. Carriage Return character is received. LFEED OFF turns this feature off.
  134. LFEED / toggles the line feed setting.
  135. [LINE INPUT]
  136. LINE INPUT var$
  137. LINE INPUT "prompt";var$
  138. Reads an entire line of input into a string variable.
  139. LINE INPUT #n,var$
  140. Reads an entire line from a file into a string variable. The line ends when
  141. a line feed is encountered, or 255 characters have been read, whichever
  142. comes first. Open text files in Ascii mode (see OPEN) for proper results.
  143. [LOAD]
  144. LOAD "file.bas" loads a Basic program into memory.
  145. See also LOAD TERM, LOAD CAPTURE, and LOAD XFER.
  146. [LOAD CAPTURE]
  147. LOAD CAPTURE "filename" loads the file into the capture buffer.
  148. [LOAD TERM]
  149. LOAD TERM "file.emu" loads a terminal emulation module. See also UNLOAD
  150. and MODE.
  151. [LOAD XFER]
  152. LOAD XFER "file.trf" loads a file transfer module. See also UNLOAD
  153. [LOG]
  154. Acts line Basic PRINT, but output goes to the capture buffer.
  155. [MENU]
  156. MENU n1,n2
  157. Allows a Basic program to simulate selecting a Storm menu item. n1 is the
  158. menu title index, where Desk=0, File=1, Edit=2, etc.
  159. n2 is the item number in the menu dropdown; the top item is number 1.
  160. [MID$]
  161. MID$(dest$,start[,length]) = new$
  162.     Replaces a portion of destination string with a new string.
  163. dest$ is a string variable or a string array reference.
  164. new$ is a string which will be used to replace a portion of dest$.
  165. Length is an optional number specifying the number of characters to
  166. replace. Start is a number specifying the position where you want to start
  167. replacing.
  168. var$ = MID$("string",Start,Count)
  169.     Returns the substring of "string" starting at location Start and
  170. continuing for Count letters. Count is optional. Omitting Count returns
  171. the string starting from location Start.
  172.     The first letter in a string is considered to start at position 1.
  173. [MKDIR]
  174. MKDIR "dirname" creates a folder (directory).
  175. [MODE]
  176. MODE "name" sets terminal emulation to "name".
  177. [OPEN]
  178. OPEN "mode",#n,"filename"
  179.     Opens a file in Basic. n is a digit from 1 to 15 which is the file
  180. number that is used in subsequent input # or print # commands.
  181. "mode" can be one of the following:
  182.     "w" creates a text file for writing, discards previous contents.
  183.     "r" opens a text file for reading.
  184.     "a" append; opens or creates a text file for writing at end of file.
  185.     "r+" opens text file for update (reading or writing).
  186.     "w+" creates text file for update, discards previous contents.
  187. Adding a "b" to mode, e.g. "wb" opens the file in binary mode. Text mode
  188. does CR->CR/LF translation so that a CR-LF combination in the file is
  189. replaced with a single line feed character when you read from the file,
  190. and vice-versa when writing to a file.
  191. [PARITY]
  192. PARITY ODD|EVEN|NONE
  193.     Sets parity for the serial port, odd, even, or no parity. Word size is
  194. automatically set to 8 bits for no parity, 7 bits for even or odd parity.
  195. [PAUSE]
  196. PAUSE nn pauses for the specified number of seconds.
  197. [PLAY]
  198. PLAY str$
  199. Uses the GEM Xbios Dosound call to play sounds.
  200. [REPLACE$]
  201. REPLACE$(dest$,start[,length]) = new$
  202.    Replace$ is a lot like MID$, except that it will expand or shrink the
  203. destination string. This means you can replace a part of string with a
  204. string that is a different length.
  205. [RMDIR]
  206. RMDIR "dirname"
  207. Deletes a directory (folder). You cannot delete a directory that contains
  208. files; you must delete all contained files first.
  209. [RUBOUT]
  210. RUBOUT ON|OFF|/
  211. Setss the terminal Destructive Backspace setting. RUBOUT ON means that
  212. backspace characters erase the previous character on a line.
  213. [SAVE]
  214. SAVE "file.bas" saves a Basic program in tokenized format.
  215. See also SAVE CAPTURE.
  216. [SAVE CAPTURE]
  217. SAVE CAPTURE "filename" saves the capture buffer to the indicated file.
  218. [SBITS]
  219. Sets stop bits used by the serial port. SBITS 3 actually sets stop bits
  220. to 1.5.
  221. [SEND]
  222. The same as Basic print, except output is to the serial port.
  223. [SET]
  224. Used to access profile file settings.
  225. Example: SET "STORM","Paths","DownloadPath","C:\DOWNLOAD\" sets the
  226. download path.
  227. SET$("STORM","Paths","DownloadPath") returns the download path as a string.
  228. SET("STORM","Terminal","LocalEcho") returns 1 if half duplex is in effect.
  229. Available profile files are "STORM","DIALDIR",and "STORMKEY"
  230. [STRIP]
  231. STRIP ON|OFF|/
  232. Sets whether the high bit is masked off from characters input from
  233. the serial port.
  234. [TA]
  235. TA ON|OFF|/
  236. Turns typeahead on or off, or toggles the state of typeahead.
  237. [TERM]
  238. TERM ON|OFF
  239. TERM OFF shuts off terminal processing of serial characters except during
  240. WAIT statements. TERM is automatically enabled during WAIT, PAUSE or
  241. KEYINPUT commands.
  242. [TOPW]
  243. TOPW by itself brings the Basic window to the top.
  244. TOPW n brings the specified window to the top. e.g.
  245. 1 is the terminal window.
  246. 2 is the capture window.
  247. 3 is the Basic window.
  248. 4 through 10 are editing windows.
  249. 11 is the file transfer window.
  250. [TYPE]
  251. The same as Basic print, except output is to the terminal screen.
  252. Note: To send output to the serial port, use SEND.
  253. [ULOAD]
  254. ULOAD("protocol","file",...)
  255. Uploads one or more files using specified protocol. Returns number of
  256. files transferred.
  257. [UNLOAD]
  258. UNLOAD TERM "name" unloads a terminal emulation. Use the name in the
  259. terminal emulations dialog, not the filename. e.g. UNLOAD TERM "VIDTEX"
  260. UNLOAD XFER "name" unloads a file transfer. Use the name in the Transfer
  261. Protocols dialog, not the filename. e.g. UNLOAD XFER "XYMODEM".
  262. [WAIT]
  263. WAIT 10,"string1","string2",...
  264.     Waits for one or more strings to be received at the serial port. The
  265. optional timeout specified how many seconds to wait. Omit the timeout to
  266. wait 'forever' (actually, 120 days).
  267.     WAIT(0) returns the result of the last WAIT command. '0' means the WAIT
  268. timed out. '1' means the first string was found, '2' means the second
  269. string was found, and so forth.
  270. [WHILE]
  271. WHILE expr
  272.     statements
  273. WEND
  274.  
  275. While the expression evaluates to TRUE, executes the statements inside the
  276. loop. If the expression is FALSE, skips to the next statement past the
  277. WEND statement. A WHILE/WEND block can span multiple lines and can begin or
  278. end in the middle of a line.
  279.  
  280.  
  281.